Skip to main content

Get list of businesses

GET /api/v1/businesses

Description​

Retrieve a list of businesses based on various query parameters.

URL:

  • Raw URL: /api/v1/businesses
  • Host:
  • Path: /api/v1/businesses

Query Parameters:

  • businessDateRange: (e.g., 2020-11-12,2022-11-15)

  • businessByKycStatus: APPROVE

  • businessByWalletAccount:

  • businessByLocations: (e.g., longitude,latitude or -40.943,29.2933)

  • businessAddress:

  • businessBySources: (Comma Separated, any of SHOP,TRACE,AGENCY,AGENT,DEAL,OWN,PLATFORM)

  • businessByTypes: (Comma Separated, any of SUPPLIER,MERCHANT,AGENCY_BANKING,SABI_AGENT,SABI_OWN)

  • businessByTenantIds:

  • businessByUserIds:

  • businessByIds:

  • businessSearch:

  • businessByIsDistributor: 1

  • businessByAcceptingOrder: 1

  • businessByActive: 1

  • order: DESC

  • page:

  • limit:

Response:

  • Status: OK (200)
/api/v1/businesses/:businessId/tenants/:tenantId/wallet/activate

🔑 Authentication bearer​

ParamvalueType
tokenbearerTokenstring

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/businesses \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!